<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Low Power Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__usbfs__dev__drv__functions__low__power.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Low Power Functions<div class="ingroups"><a class="el" href="group__group__usbfs__dev__drv.html">USBFS        (USB Full-Speed Device)</a> &raquo; <a class="el" href="group__group__usbfs__dev__drv__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>The Low-power functions provide an API to implement Low-power callback at the application level. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabd7fa97f9881ff3992851fecb9fa6ca2"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__low__power.html#gabd7fa97f9881ff3992851fecb9fa6ca2">Cy_USBFS_Dev_Drv_CheckActivity</a> (USBFS_Type *base)</td></tr>
<tr class="memdesc:gabd7fa97f9881ff3992851fecb9fa6ca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the activity status of the bus.  <a href="#gabd7fa97f9881ff3992851fecb9fa6ca2">More...</a><br /></td></tr>
<tr class="separator:gabd7fa97f9881ff3992851fecb9fa6ca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb6514f79104fe1ad21cd68a155808b5"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__low__power.html#gaeb6514f79104fe1ad21cd68a155808b5">Cy_USBFS_Dev_Drv_Force</a> (USBFS_Type *base, <a class="el" href="group__group__usbfs__dev__drv__enums.html#ga460ea6ba6179dd6fad514ba26c982e92">cy_en_usbfs_dev_drv_force_bus_state_t</a> state)</td></tr>
<tr class="memdesc:gaeb6514f79104fe1ad21cd68a155808b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forces a USB J, K, or SE0 state on the USB lines.  <a href="#gaeb6514f79104fe1ad21cd68a155808b5">More...</a><br /></td></tr>
<tr class="separator:gaeb6514f79104fe1ad21cd68a155808b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e254e18f758dbc14cb74b6ef93fc705"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__low__power.html#ga1e254e18f758dbc14cb74b6ef93fc705">Cy_USBFS_Dev_Drv_Suspend</a> (USBFS_Type *base, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga1e254e18f758dbc14cb74b6ef93fc705"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepares the USBFS component to enter Deep Sleep mode.  <a href="#ga1e254e18f758dbc14cb74b6ef93fc705">More...</a><br /></td></tr>
<tr class="separator:ga1e254e18f758dbc14cb74b6ef93fc705"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f96e219508bc0ea6d645d79ebb75c34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__low__power.html#ga4f96e219508bc0ea6d645d79ebb75c34">Cy_USBFS_Dev_Drv_Resume</a> (USBFS_Type *base, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga4f96e219508bc0ea6d645d79ebb75c34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepares the USBFS component for operation after exiting Deep Sleep mode.  <a href="#ga4f96e219508bc0ea6d645d79ebb75c34">More...</a><br /></td></tr>
<tr class="separator:ga4f96e219508bc0ea6d645d79ebb75c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabd7fa97f9881ff3992851fecb9fa6ca2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabd7fa97f9881ff3992851fecb9fa6ca2">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_CheckActivity()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE bool Cy_USBFS_Dev_Drv_CheckActivity </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the activity status of the bus. </p>
<p>It clears the hardware status to provide an updated status on the next call of this function. This function is useful to determine whether there is any USB bus activity between function calls. A typical use case is to determine whether the USB suspend conditions are met.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The bus activity since the last call. </dd></dl>

</div>
</div>
<a id="gaeb6514f79104fe1ad21cd68a155808b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb6514f79104fe1ad21cd68a155808b5">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Force()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_Force </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__usbfs__dev__drv__enums.html#ga460ea6ba6179dd6fad514ba26c982e92">cy_en_usbfs_dev_drv_force_bus_state_t</a>&#160;</td>
          <td class="paramname"><em>state</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Forces a USB J, K, or SE0 state on the USB lines. </p>
<p>A typical use case is to signal a Remote Wakeup condition on the USB bus.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">state</td><td>The desired bus state. See <a class="el" href="group__group__usbfs__dev__drv__enums.html#ga460ea6ba6179dd6fad514ba26c982e92">cy_en_usbfs_dev_drv_force_bus_state_t</a> for the set of constants. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga1e254e18f758dbc14cb74b6ef93fc705"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1e254e18f758dbc14cb74b6ef93fc705">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Suspend()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_Suspend </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prepares the USBFS component to enter Deep Sleep mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>After entering low-power mode, the data that is left in the IN or OUT endpoint buffers is not restored after a wakeup, and is lost. Therefore, it should be stored in the SRAM for OUT endpoint or read by the host for the IN endpoint before entering low-power mode. </dd></dl>

</div>
</div>
<a id="ga4f96e219508bc0ea6d645d79ebb75c34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f96e219508bc0ea6d645d79ebb75c34">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Resume()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_Resume </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prepares the USBFS component for operation after exiting Deep Sleep mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
